Getting Started with the OnlinePay APIs

Overview

Westpac OnlinePay enables you to securely accept online payments using a range of integration methods, from fully hosted payment experiences to customised browser-based and Server-to-Server API integrations.

This documentation helps you to:

• Choose the integration method that best suits your business requirements.
• Configure and authenticate access to OnlinePay APIs.
• Process payments and manage transactions.
• Integrate OnlinePay into your website, application, or business processes.

Before you begin

Before integrating with OnlinePay, you'll need an active OnlinePay account and the credentials and configuration values required for your chosen integration method.

Depending on your integration, these may include:

• API key
• User ID
• Entity ID
• Payment Provider Contract (PPC)
• 3D Secure Contract

API keys are used to authenticate requests to OnlinePay APIs and allow you to perform actions on behalf of your account.

Other configuration values identify your account, contracts, and services and are used with your API credentials when making requests to OnlinePay.

Choose an integration method

OnlinePay provides several ways to accept payments, ranging from fully hosted payment experiences to direct API integrations.

You can choose from the following:

• Hosted Payments Page (HPP) for a fully hosted payment experience.
• iFrame to embed an OnlinePay-hosted payment form within your website.
• Pay by Link to send payment requests to customers without building a checkout experience.
• Verifone.js for a customised checkout experience with browser-based card data capture and encryption.
• Server-to-Server API for direct integration with OnlinePay APIs and greater control over the payment experience.

See Integration methods to compare the available options and their PCI DSS requirements.